µC/OS-II Abstraction Layer

The Kinetis SDK provides the µC/OS-II Abstraction Layer for synchronization, mutual exclusion, message queue, etc. More...

Data Structures
struct	EVENT_UCOSII
	Type for an event group object in uCOS-II. More...
struct	MSGQ_STRUCT_UCOSII
	Type for message queue in uCOS-II. More...

Macros
#define	kSyncWaitForever   0xFFFFFFFFU
	Constant to pass as timeout value in order to wait indefinitely. More...
#define	FSL_RTOS_CURRENT_TASK   ((task_handler_t)OS_PRIO_SELF)
	Macro passed to the task_destroy function to destroy the current task.

Typedefs
typedef INT8U	task_handler_t
	Type for a task handler, returned by the task_create function.
typedef OS_STK	task_stack_t
	Type for a task stack.
typedef OS_FLAGS	event_group_t
	Type for an event flags group.
typedef OS_EVENT *	sync_object_t
	Type for an synchronization object.
typedef OS_EVENT *	lock_object_t
	Type for a resource locking object.
typedef EVENT_UCOSII	event_object_t
	Type for an event group object.
typedef MSGQ_STRUCT_UCOSII	msg_queue_t
	Type for a message queue declaration and creation.
typedef MSGQ_STRUCT_UCOSII *	msg_queue_handler_t
	Type for a message queue handler.
typedef void *	msg_queue_item_t
	Type for a message queue item.
typedef void(*	task_t )(void *start)
	Type for a task pointer.

Thread management
#define	FSL_RTOS_TASK_DEFINE(task, stackSize, name, usesFloat)
	Creates a task descriptor that is used to create the task with task_create. More...
#define	task_create(task, priority, param, handler)
	Creates and sets the task to active. More...

Synchronization
#define	sync_object_declare(obj)   sync_object_t obj = (sync_object_t)0
	Create the synchronization object. More...

Resource locking
#define	lock_object_declare(obj)   lock_object_t obj = (lock_object_t)0
	Create the locking object. More...

Message queues
#define	MSG_QUEUE_DECLARE(name, number, size)
	This macro statically reserves the memory required for the queue. More...

Critical Sections
#define	rtos_enter_critical   OS_ENTER_CRITICAL
	Ensures the following code will not be preempted.
#define	rtos_exit_critical   OS_EXIT_CRITICAL
	Allows preemption.

---

Data Structure Documentation

struct EVENT_UCOSII

Data Fields
OS_FLAG_GRP *	pGrp
	Pointer to uCOS-II's event entity.
event_clear_type	clearType
	Auto clear or manual clear.

struct MSGQ_STRUCT_UCOSII

Data Fields
OS_EVENT *	pq
	pointer to the queue
void **	msgTbl
	pointer to the array that saves the pointers to messages
uint16_t	size
	size of the message in words

Macro Definition Documentation

#define kSyncWaitForever   0xFFFFFFFFU

#define FSL_RTOS_TASK_DEFINE	(		task,
			stackSize,
			name,
			usesFloat
	)

Value:

task_stack_t fslTaskStack_##task[(stackSize)/sizeof(task_stack_t)]; \
    uint8_t fslTaskName_##task[] = name;                                \
    bool fslTaskFloatUse_##task = usesFloat

Parameters

task	The task function.
stackSize	Number of elements in the stack for this task.
name	String to assign to the task.
usesFloat	Boolean that indicates whether the task uses the floating point unit.

#define task_create	(		task,
			priority,
			param,
			handler
	)

Value:

__task_create(task,                                             \
                  fslTaskName_##task,                               \
                  sizeof(fslTaskStack_##task),                      \
                  fslTaskStack_##task,                              \
                  priority,                                         \
                  param,                                            \
                  fslTaskFloatUse_##task,                           \
                  handler)

Parameters

task	The task function.
priority	Initial priority of the task.
param	Pointer to be passed to the task when it is created.
handler	Returns the identifier to be used afterwards to destroy the task.

Return values

kSuccess	The task was successfully created.
kError	Creation of task failed.

#define sync_object_declare

(

obj

)

sync_object_t obj = (sync_object_t)0

To be used instead of a standard declaration.

Parameters

obj	The sync object to create.

#define lock_object_declare

(

obj

)

lock_object_t obj = (lock_object_t)0

To be used instead of a standard declaration.

Parameters

obj	The lock object to create.

#define MSG_QUEUE_DECLARE	(		name,
			number,
			size
	)

Value:

void* msgTbl##name[number];               \
    msg_queue_t name = {                      \
        .msgTbl = msgTbl##name                \
    }

Parameters

name	Identifier for the memory region.
number	Number of elements in the queue.
size	Size of every elements in words.